Added documentation about how to set up OAuth applications
Dominik Sander
5 changed files with 6 additions and 16 deletions
+ 2
- 0
app/models/agents/basecamp_agent.rb
@@ -8,6 +8,8 @@ module Agents |
||
| 8 | 8 |
description <<-MD |
| 9 | 9 |
The BasecampAgent checks a Basecamp project for new Events |
| 10 | 10 |
|
| 11 |
+ To be able to use this Agent you need to authenticate with 37signals in the [Services](/services) section first. |
|
| 12 |
+ |
|
| 11 | 13 |
You need to provide the `project_id` of the project you want to monitor. |
| 12 | 14 |
If you have your Basecamp project opened in your browser you can find the user_id and project_id as follows: |
| 13 | 15 |
|
+ 1
- 5
app/models/agents/twitter_publish_agent.rb
@@ -10,11 +10,7 @@ module Agents |
||
| 10 | 10 |
description <<-MD |
| 11 | 11 |
The TwitterPublishAgent publishes tweets from the events it receives. |
| 12 | 12 |
|
| 13 |
- Twitter credentials must be supplied as either [credentials](/user_credentials) called |
|
| 14 |
- `twitter_consumer_key`, `twitter_consumer_secret`, `twitter_oauth_token`, and `twitter_oauth_token_secret`, |
|
| 15 |
- or as options to this Agent called `consumer_key`, `consumer_secret`, `oauth_token`, and `oauth_token_secret`. |
|
| 16 |
- |
|
| 17 |
- To get oAuth credentials for Twitter, [follow these instructions](https://github.com/cantino/huginn/wiki/Getting-a-twitter-oauth-token). |
|
| 13 |
+ To be able to use this Agent you need to authenticate with Twitter in the [Services](/services) section first. |
|
| 18 | 14 |
|
| 19 | 15 |
You must also specify a `message` parameter, you can use [Liquid](https://github.com/cantino/huginn/wiki/Formatting-Events-using-Liquid) to format the message. |
| 20 | 16 |
|
+ 1
- 5
app/models/agents/twitter_stream_agent.rb
@@ -10,11 +10,7 @@ module Agents |
||
| 10 | 10 |
To follow the Twitter stream, provide an array of `filters`. Multiple words in a filter must all show up in a tweet, but are independent of order. |
| 11 | 11 |
If you provide an array instead of a filter, the first entry will be considered primary and any additional values will be treated as aliases. |
| 12 | 12 |
|
| 13 |
- Twitter credentials must be supplied as either [credentials](/user_credentials) called |
|
| 14 |
- `twitter_consumer_key`, `twitter_consumer_secret`, `twitter_oauth_token`, and `twitter_oauth_token_secret`, |
|
| 15 |
- or as options to this Agent called `consumer_key`, `consumer_secret`, `oauth_token`, and `oauth_token_secret`. |
|
| 16 |
- |
|
| 17 |
- To get oAuth credentials for Twitter, [follow these instructions](https://github.com/cantino/huginn/wiki/Getting-a-twitter-oauth-token). |
|
| 13 |
+ To be able to use this Agent you need to authenticate with Twitter in the [Services](/services) section first. |
|
| 18 | 14 |
|
| 19 | 15 |
Set `expected_update_period_in_days` to the maximum amount of time that you'd expect to pass between Events being created by this Agent. |
| 20 | 16 |
|
+ 1
- 5
app/models/agents/twitter_user_agent.rb
@@ -9,11 +9,7 @@ module Agents |
||
| 9 | 9 |
description <<-MD |
| 10 | 10 |
The TwitterUserAgent follows the timeline of a specified Twitter user. |
| 11 | 11 |
|
| 12 |
- Twitter credentials must be supplied as either [credentials](/user_credentials) called |
|
| 13 |
- `twitter_consumer_key`, `twitter_consumer_secret`, `twitter_oauth_token`, and `twitter_oauth_token_secret`, |
|
| 14 |
- or as options to this Agent called `consumer_key`, `consumer_secret`, `oauth_token`, and `oauth_token_secret`. |
|
| 15 |
- |
|
| 16 |
- To get oAuth credentials for Twitter, [follow these instructions](https://github.com/cantino/huginn/wiki/Getting-a-twitter-oauth-token). |
|
| 12 |
+ To be able to use this Agent you need to authenticate with Twitter in the [Services](/services) section first. |
|
| 17 | 13 |
|
| 18 | 14 |
You must also provide the `username` of the Twitter user to monitor. |
| 19 | 15 |
|
+ 1
- 1
app/views/services/index.html.erb
@@ -8,7 +8,7 @@ |
||
| 8 | 8 |
</div> |
| 9 | 9 |
<p> |
| 10 | 10 |
Before you can authenticate with a service, you need to set it up. Have a look at the |
| 11 |
- <%= link_to 'wiki', 'tobedone', target: :_blank %> |
|
| 11 |
+ <%= link_to 'wiki', 'https://github.com/cantino/huginn/wiki/Configuring-OAuth-applications', target: :_blank %> |
|
| 12 | 12 |
for guidance. |
| 13 | 13 |
</p> |
| 14 | 14 |
<p><%= link_to "Authenticate with Twitter", "/auth/twitter" %></p> |